IBM Endpoint Manager Inspectors Reference

Terminology

Win: Windows
Lin: Red Hat and SUSE Linux
Sol: SUN Solaris
HPUX: Hewlett-Packard UNIX version
AIX: IBM AIX
Mac: Apple Macintosh
Ubu: Ubuntu/Debian
WM: Windows Mobile

The version (e.g. Lin:8.1) corresponds to the version of the IEM product (8.1) in which the inspector was introduced in the client on that platform.
The version number is not shown if it is less than 8.0.


Platform


Contents

Action Objects
Authorization Objects
Client Objects
Directory Services
Environment Objects
Filesystem Objects
application
bundle
component
country
datafork
device file
dictionary
dictionaryentry
domain
download storage folder
drive
fifo file
file
file content
file line
file section
file shortcut
file signature
file type
file version block
fileset
filesystem
filesystem object
folder
logical volume
logical volume manager
mode
mode_mask
osxvalue
preference
resfork
socket file
stage
strverscmp version
symlink
version
version with multiplicity
volume
volume group
xml dom node
Firewall Objects
Fixlet Objects
Formatting Objects
Installed System Software
Introspectors
License Objects
Microsoft IIS Metabase Objects
Miscellaneous
Networking Objects
Power Objects
Primitive Objects
Registry Objects
Session Objects
Session Statistics
Site Objects
SMBIOS objects
System Objects
Task Objects
User Objects
Windows Mobile Device Objects
WMI Objects
World Objects

IBM Endpoint Manager wiki

Filesystem Objects

This chapter covers the keywords for extracting information from the file system, like files, drives, pathnames, folders, etc. It also includes the keywords needed to identify and compare version information of files and patches.For more information on special Windows folders, see the Resources section at the end of this guide.

filesystem

The filesystem object can be used to inspect various aspects of mounted file systems, including the format of the file system. Here are some of the possible format types:affsext, ext2, ext2_oldhpfsisominix, minix_30, minix2, minix2_30 msdos ncpnfsprocsmbxenixsysv4, sysv2cohufsxia

Creation Methods

DeclarationDescriptionPlatforms (?)
driveIterates through all valid drives on the system. Typically used to return a list of the drives (volumes, filesystems) on the client computer. On Windows computers, this returns a <drive> object.On *nix computers, this returns a <filesystem> object.Drives, volumes and filesystems are treated the same on the Macintosh and return a <volume> type.

Example:
names of drives - Returns a list of drives, eg., C:, D:, etcetera.
Lin, Sol, HPUX, AIX, Ubu:8.1
drive <string>Returns the drive associated with the pathname specified by <string>. On Windows computers, this returns a <drive> object.On Macintosh computers, this returns a <volume> object.On *nix computers, this returns a <filesystem> object.Lin, Sol, HPUX, AIX, Ubu:8.1
filesystemReturns the volume corresponding to the filesystem. Typically used to return a list of the filesystems (drives, volumes) on the client computer. Drives, volumes and filesystems are treated the same on the Macintosh and return a <volume> type.

Example:
names of filesystems - Returns the names of the mounted file systems.
Lin, Sol, HPUX, AIX, Ubu:8.1
filesystem <string>Returns the filesystem corresponding to the specified name. On a Macintosh, this Inspector returns a <volume> object.Lin, Sol, HPUX, AIX, Ubu:8.1
drive of <file>Returns the drive associated with the specified file. On Macintosh computers, this returns a <volume> object.On *nix computers, this returns a <filesystem> object.Win, Lin, Sol, HPUX, AIX, Ubu:8.1
filesystem of <file>Returns the UNIX filesystem flag for the given file. On a Macintosh, this returns a <volume> object.Lin, Sol, HPUX, AIX, Ubu:8.1
drive of <folder>Returns the drive associated with the specified folder.On Macintosh computers, this returns a <volume> object.On *nix computers, this returns a <filesystem> object.Lin, Sol, HPUX, AIX, Ubu:8.1
filesystem of <folder>Returns the filesystem on which the folder resides. On a Macintosh, this Inspector returns a <volume> object.Lin, Sol, HPUX, AIX, Ubu:8.1
drive of <symlink>Returns the drive associated with the specified symlink as a <filesystem> object.Lin, Sol, HPUX, AIX, Ubu:8.1
filesystem of <symlink>Returns the filesystem on which the symlink resides.Lin, Sol, HPUX, AIX, Ubu:8.1
drive of <device file>Returns the drive associated with the specified device file.Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Ubu:8.1
filesystem of <device file>Returns the filesystem object corresponding to the specified device file.Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Ubu:8.1
drive of <fifo file>Returns the drive associated with the specified FIFO (named pipe) file.Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Ubu:8.1
filesystem of <fifo file>Returns the filesystem object corresponding to the specified FIFO file.Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Ubu:8.1
drive of <socket file>Returns the drive associated with the specified socket file.Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Ubu:8.1
filesystem of <socket file>Returns the filesystem object corresponding to the specified socket file.Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Ubu:8.1

Properties

DeclarationReturn typeDescriptionPlatforms (?)
volume of <filesystem><string>

Plural: volumes
This is a <Plain> property inspector that takes a <filesystem> type and returns a <volume> type.Ubu:9.0, Lin:9.0, HPUX:9.0, AIX:9.0, Sol:9.0
file count of <filesystem><integer>

Plural: file counts
Returns the total number of files that may be saved on this filesystem.Lin, Sol, HPUX, AIX, Ubu:8.1
free file count of <filesystem><integer>

Plural: free file counts
Returns the number of files available on this filesystem.Lin, Sol, HPUX, AIX, Ubu:8.1
free percent of <filesystem><integer>

Plural: free percents
Returns the percentage of the file system currently available.Lin, Sol, HPUX, AIX, Ubu:8.1
free space of <filesystem><integer>

Plural: free spaces
Returns the number of bytes on this filesystem.Lin, Sol, HPUX, AIX, Ubu:8.1
name of <filesystem><string>

Plural: names
Returns the mount point of the filesystem object.Lin, Sol, HPUX, AIX, Ubu:8.1
size of <filesystem><integer>

Plural: sizes
Returns the total number of bytes on this file system (same as total space).Lin, Sol, HPUX, AIX, Ubu:8.1
total space of <filesystem><integer>

Plural: total spaces
Returns the total number of bytes on this file system (same as size).Lin, Sol, HPUX, AIX, Ubu:8.1
type of <filesystem><string>

Plural: types
Returns the filesystem format type, as listed in the type header.Lin, Sol, HPUX, AIX, Ubu:8.1
used file count of <filesystem><integer>

Plural: used file counts
The number of files in use on this filesystem.Lin, Sol, HPUX, AIX, Ubu:8.1
used percent of <filesystem><integer>

Plural: used percents
Returns the percentage of the file system currently in use.Lin, Sol, HPUX, AIX, Ubu:8.1
used space of <filesystem><integer>

Plural: used spaces
Returns the number of bytes on this filesystem currently in use.Lin, Sol, HPUX, AIX, Ubu:8.1

filesystem object

The <filesystem object> Inspectors provide handles for the various objects available in the file system.

Creation Methods

DeclarationDescriptionPlatforms (?)

Operators

DeclarationReturn TypeDescriptionPlatforms (?)

Properties

DeclarationReturn typeDescriptionPlatforms (?)
change time of <filesystem object><time>

Plural: change times
Returns the last time the specified filesystem object was changed by either writing it or setting its inode information.Ubu:8.1, Lin, HPUX, AIX, Sol
<filesystem object> as device file<device file>Returns a device file or nothing (if the filesystem object specified is not a device file).Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Ubu:8.1
<filesystem object> as fifo file<fifo file>Returns a FIFO file or nothing (if the filesystem object specified is not a FIFO file).Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Ubu:8.1
<filesystem object> as socket file<socket file>Casts a given filesystem object as a socket file.Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Ubu:8.1
<filesystem object> as string<string>Casts a filesystem object as a string.Win:8.0, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
<filesystem object> as symlink<symlink>Casts a link in the form of a file into a symlink.Lin, Sol, HPUX, AIX, Ubu:8.1
accessed time of <filesystem object><time>

Plural: accessed times
When the filesystem object (file or folder) was last accessed. Some file systems maintain this property.Win, Lin, Sol, HPUX, AIX, WM, Ubu:8.1
ancestor of <filesystem object><folder>

Plural: ancestors
Returns all ancestor folders (recursive parent folders) of the given filesystem object (file or folder).Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
gid of <filesystem object><integer>

Plural: gids
Returns the group ID of the given filesystem object.Lin, Sol, HPUX, AIX, Ubu:8.1
group execute of <filesystem object><boolean>

Plural: group executes
Returns TRUE if the group execute flag is set for the given filesystem object.Lin, Sol, HPUX, AIX, Ubu:8.1
group mask of <filesystem object><integer>

Plural: group masks
Returns the group permission mask of the given filesystem object.Lin, Sol, HPUX, AIX, Ubu:8.1
group name of <filesystem object><string>

Plural: group names
Returns the group name of the given filesystem object.Lin, Sol, HPUX, AIX, Ubu:8.1
group read of <filesystem object><boolean>

Plural: group reads
Returns TRUE if the group read flag is set for the given filesystem object.Lin, Sol, HPUX, AIX, Ubu:8.1
group write of <filesystem object><boolean>

Plural: group writes
Returns TRUE if the group write flag is set for the given filesystem object.Lin, Sol, HPUX, AIX, Ubu:8.1
link count of <filesystem object><integer>

Plural: link counts
Returns an integer corresponding to the number of hard links attached to the specified filesystem object.Lin, Sol, HPUX, AIX, Ubu:8.1
location of <filesystem object><string>

Plural: locations
Returns the name of the directory in which the file or folder (filesystem object) is located.Win, Lin, Sol, HPUX, AIX, WM, Ubu:8.1
mode of <filesystem object><mode>

Plural: modes
Returns the permissions mode for the given filesystem object.Lin, Sol, HPUX, AIX, Ubu:8.1
modification time of <filesystem object><time>

Plural: modification times
The date and time of latest modification of the file. This corresponds to what is shown in the "Get Info" box.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
name of <filesystem object><string>

Plural: names
This returns the name of the file or folder.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
other execute of <filesystem object><boolean>

Plural: other executes
Returns TRUE if others (not in the group) have execute permissions on the given filesystem object.Lin, Sol, HPUX, AIX, Ubu:8.1
other mask of <filesystem object><integer>

Plural: other masks
Returns the other (not in the group) mask as a 3-bit integer corresponding to rwx permissions for the specified filesystem object.Lin, Sol, HPUX, AIX, Ubu:8.1
other read of <filesystem object><boolean>

Plural: other reads
Returns TRUE if others (not in the group) have read permissions on the given filesystem object.Lin, Sol, HPUX, AIX, Ubu:8.1
other write of <filesystem object><boolean>

Plural: other writes
Returns TRUE if others (not in the group) have write permissions on the given filesystem object.Lin, Sol, HPUX, AIX, Ubu:8.1
parent folder of <filesystem object><folder>

Plural: parent folders
The folder containing the specified file or folder.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
pathname of <filesystem object><string>

Plural: pathnames
Returns the full pathname of the specified file or folder (filesystem object) as a string.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
setgid of <filesystem object><boolean>

Plural: setgids
Returns TRUE if the setgid (group ID) bit is set for the specified filesystem object.Lin, Sol, HPUX, AIX, Ubu:8.1
setuid of <filesystem object><boolean>

Plural: setuids
Returns TRUE if the setuid (user ID) bit is set for the specified filesystem object.Lin, Sol, HPUX, AIX, Ubu:8.1
uid of <filesystem object><integer>

Plural: uids
The user ID of the user who owns this filesystem object.Lin, Sol, HPUX, AIX, Ubu:8.1
user execute of <filesystem object><boolean>

Plural: user executes
Returns TRUE if the owner (user) has execute permissions on the given filesystem object.Lin, Sol, HPUX, AIX, Ubu:8.1
user mask of <filesystem object><integer>

Plural: user masks
Integer representing user permissions (3 bit mask, RWX) on the specified filesystem object.Lin, Sol, HPUX, AIX, Ubu:8.1
user name of <filesystem object><string>

Plural: user names
Returns the owner (user) name of the specified filesystem object.Lin, Sol, HPUX, AIX, Ubu:8.1
user read of <filesystem object><boolean>

Plural: user reads
Returns the owner (user) read permissions for the specified filesystem object.Lin, Sol, HPUX, AIX, Ubu:8.1
user write of <filesystem object><boolean>

Plural: user writes
Returns the owner (user) write permissions for the specified filesystem object.Lin, Sol, HPUX, AIX, Ubu:8.1

file

For each file in the file system, you can create a corresponding file object and inspect its properties. Inspectors are also provided to look at version data of executable files.Note: File systems that do not maintain the creation or last accessed times will often return the last modification time when queried for the creation or last accessed times or files. Modification times are preserved when files are copied. Thus, it is not uncommon to see a file that appears to have been modified before it was created.

Creation Methods

DeclarationDescriptionPlatforms (?)
default web browserCreates an object corresponding to the default web browser. This is a *nix inspector; it will fail gracefully on other operating systems instead of generating an error.Lin, Sol, HPUX, AIX, Ubu:8.1
download file <string>This inspector is available in relevance subsitution action processing. It returns a file object with the given name from the named folder or the download folder. This is equivalent to 'file "name" of download folder'. The file should exist or the result will not exist.

Example:
wait "{pathname of download file "update.exe"}" - In an Action script, this line causes the BES Client to perform relevance substitution to compute the full path to the downloaded file (previously collected by a download command in the same Action script). After relevance substitution, the Client launches the specified executable and waits for it to complete before moving on to other Action lines.
Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
file <string>Returns a filesystem object corresponding to the full pathname provided in <string>.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
file <symlink>Returns the file pointed to by the specified symlink. If the file doesn't exist, this Inspector will throw a 'non-existent object' error.Lin, Sol, HPUX, AIX, Ubu:8.1
descendant of <folder>Returns a list of all the descendant files of the specified folder.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
file <string> of <folder>Returns a file object for the named file located in the folder.

Example:
exists file whose (name of it contains ".pdf") of folder "name" - Returns TRUE if some file in the folder has a name including the string ".pdf".
Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
file of <folder>Iterates through the files of a folder returning file objects. When combined with a whose clause you can select files with specific properties. See file.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
find file <string> of <folder>Iterates through the files of a folder returning file objects whose name matches the wildcard string provided in the name parameter. A wildcard string uses an asterisk to stand for any number of characters (incuding zero), and a question mark to stand for exactly one character. Thus A??.txt would match All.txt and AXE.txt but not all.txt or a.txt. See example below.

Example:
Number of find files "siteico*.bmp" of client folder of current site = 3 - Returns TRUE if there are 3 files matching the wildcard pattern siteico*.bmp.

Example:
names of find files "*.exe" of windows folder - Returns a list of the names of all the executable programs in the Windows folder.
Win, Lin, Sol, HPUX, AIX, Mac:8.0, WM, Ubu:8.1
<symlink> as fileConverts a symlink object into the file it points to.Lin, Sol, HPUX, AIX, Ubu:8.1
masthead of <site>Each site has a masthead, and the masthead is saved into the site data folder upon successful creation. This property returns a file object that corresponds to the copy in the site data folder.

Example:
modification time of masthead of current site < time "4 Aug 1997 01:00 pdt" - Returns TRUE if the masthead of the current site is older than the specified date.
Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1

Properties

DeclarationReturn typeDescriptionPlatforms (?)
md5 of <file><string>

Plural: md5s
Returns the md5 of the file, hex encoded as a stringUbu:9.0, Lin:9.0, Mac:9.0, HPUX:9.0, AIX:9.0, Sol:9.0, Win:9.0
sha2_224 of <file><string>

Plural: sha2_224s
Returns the sha2-224 of the file, hex encoded as a stringUbu:9.0, Lin:9.0, Mac:9.0, HPUX:9.0, AIX:9.0, Sol:9.0, Win:9.0
sha2_256 of <file><string>

Plural: sha2_256s
Returns the sha2-256 of the file, hex encoded as a stringUbu:9.0, Lin:9.0, Mac:9.0, HPUX:9.0, AIX:9.0, Sol:9.0, Win:9.0
sha2_384 of <file><string>

Plural: sha2_384s
Returns the sha2-384 of the file, hex encoded as a stringUbu:9.0, Lin:9.0, Mac:9.0, HPUX:9.0, AIX:9.0, Sol:9.0, Win:9.0
sha2_512 of <file><string>

Plural: sha2_512s
Returns the sha2-512 of the file, hex encoded as a stringUbu:9.0, Lin:9.0, Mac:9.0, HPUX:9.0, AIX:9.0, Sol:9.0, Win:9.0
<file> as string<string>Creates a string containing the full pathname of the specified file. See <file>.Win, Lin, Sol, HPUX, AIX, WM
byte <integer> of <file><integer>

Plural: bytes
Returns the numeric value of the byte located at the offset specified by number within the file. Byte 0 of the file is the first byte.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
content of <file><file content>

Plural: contents
Returns an object that can be used to search for a string in the file. See content.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
drive of <file><filesystem>

Plural: drives
Returns the drive associated with the specified file. On Macintosh computers, this returns a <volume> object.On *nix computers, this returns a <filesystem> object.Win, Lin, Sol, HPUX, AIX, Ubu:8.1
filesystem of <file><filesystem>

Plural: filesystems
Returns the UNIX filesystem flag for the given file. On a Macintosh, this returns a <volume> object.Lin, Sol, HPUX, AIX, Ubu:8.1
key <string> of <file><string>

Plural: keys
Returns a key and its value from the given structured text file. It iterates over lines that start with the key name (as specified by <string>) followed by an = or : character. When searching, white space is ignored.Win, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
line <integer> of <file><file line>

Plural: lines
Returns the nth line (specified by <integer>) from the given file.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
line containing <string> of <file><file line>

Plural: lines containing
Returns all lines from the given file that contain the specified string.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
line of <file><file line>

Plural: lines
Iterates over all the lines of the specified file. Note that the lines are truncated to 1023 characters.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
line starting with <string> of <file><file line>

Plural: lines starting with
Same as line <string> of <file>, returns the lines of the given file that start with the specified string.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
section <string> of <file><file section>

Plural: sections
Returns a named section of a file. Useful for locating sections of 'ini' files. Section names are delimited by square bracket characters '[section name]'. See examples below.Win, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
sha1 of <file><string>

Plural: sha1s
Returns the sha1 checksum of the file hex encoded as a 40 character long string.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
size of <file><integer>

Plural: sizes
Returns the size in bytes of a file.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
variable of <file><string>

Plural: variables
Returns the names of variables contained in an INF style file, in the format [section].name=value.Win, Lin, Sol, HPUX, AIX, WM, Ubu:8.1

application

Application objects derive from file objects. Therefore, application objects inherit all of the properties of the file object. This means that you can inspect properties such as 'modification time' or 'Product Version' of an application just as you would a file. See the properties of a file object for a complete list of these. The real power and primary purpose of the application object is their creation. The creation methods are optimized in anticipation of the importance of this object.Note: See File' for a list of the Application properties. Folder and file names may be case sensitive. Use "as uppercase" or "as lowercase" if you don't know the actual case when making comparisons. For Windows versions of these Inspectors, a properly installed application will register itself with the operating system. It does this by creating a registry sub-key usually named after the executable. The regapp Inspector uses the default value of this sub-key as a string that is the full pathname of the executable.

Creation Methods

DeclarationDescriptionPlatforms (?)

Properties

DeclarationReturn typeDescriptionPlatforms (?)

folder

For every folder that exists in the file system, you can create a folder object. These Inspectors allow you to examine dozens of properties of folder objects. On the Macintosh, there are dozens of specialized folders; access to them depends on the domain. If the domain is not specified, it defaults to the system domain.

Creation Methods

DeclarationDescriptionPlatforms (?)
download folderThis inspector is available in relevance subsitution action processing. When the action is active, this inspector returns a folder object of __Download\, otherwise it returns a folder object of __Global\sitename\actionid\named. This inspector is designed for the prefetch process of action execution. Macintosh Note: Prior to version 7.2, this Inspector referred to the system download folder on the Macintosh. That Inspector is referred to as ISS Download as of version 7.2.

Example:
wait "{pathname of file "update.exe" of download folder}" - In an Action script, this line causes the BES Client to perform relevance substitution to compute the full path to the downloaded file (previously collected by a download command in the same Action script). After relevance substitution, the Client launches the specified executable and waits for it to complete before moving on to other Action lines.
Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.2
folder <string>Returns a folder object for the name provided. See drive.

Example:
exists folder "c:\program files" - Checks for the existence of the program files folder.

Example:
exists folder "/usr/lib" - Checks for the existence of the usr/lib folder.

Example:
exists folder "/usr/lib" - Checks for the existence of the usr/lib folder.
Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
folder <symlink>Returns the folder pointed to by the specified symlink.Lin, Sol, HPUX, AIX, Ubu:8.1
root folderReturns the folder corresponding to '/'.Lin, Sol, HPUX, AIX, Ubu:8.1
ancestor of <filesystem object>Returns all ancestor folders (recursive parent folders) of the given filesystem object (file or folder).Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
parent folder of <filesystem object>The folder containing the specified file or folder.

Example:
posix paths of items whose (name of it starts with "i") of applications folder - Returns a list of the paths of applications starting with "i", such as /Applications/iCal.app, /Applications/iChat.app or /Applications/iTunes.app.
Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
descendant folder of <folder>Returns the descendant folders, recursively, of the given folder. The folder equivalent of "descendants of <folder>".Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
find folder <string> of <folder>Finds the folder with the given wildcard name inside another folder. A wildcard string uses an asterisk to stand for any number of characters (incuding zero), and a question mark to stand for exactly one character. Thus A??.txt would match All.txt and AXE.txt but not all.txt or a.txt.Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1
folder <string> of <folder>Returns a folder object for the named sub-folder. Trailing slashes should be omitted from the name.

Example:
exists folder "fonts" of the windows folder - Returns TRUE if fonts is a subdirectory of the Windows directory.

Example:
exists folder "tmp" of root folder - Returns TRUE if tmp is a subdirectory of the root directory.

Example:
exists folder "tmp" of root folder - Returns TRUE if tmp is a subdirectory of the root directory.
Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
folder of <folder>Iterates through the folders of a folder returning folder objects. When combined with a whose clause, you can select folders with specific properties.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<symlink> as folderConverts a symlink object into the folder it points to.Lin, Sol, HPUX, AIX, Ubu:8.1
ancestor of <symlink>Returns all ancestor folders (recursive parent folders) of the given symlink.Lin, Sol, HPUX, AIX, Ubu:8.1
parent folder of <symlink>Creates a folder object corresponding to the parent folder of the given symlink.Lin, Sol, HPUX, AIX, Ubu:8.1
client folder of <site>The folder containing the site content on the client machine. Site content is gathered into this location.

Example:
exists file "siteicon.bmp" of client folder of current site - TRUE if the specified file exists in the client folder.
Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
data folder of <client>Returns the __BESData folderUbu:9.0, Lin:9.0, Mac:9.0, HPUX:9.0, AIX:9.0, Sol:9.0, Win:9.0

Properties

DeclarationReturn typeDescriptionPlatforms (?)
system folderfolder

Plural: system folders
Windows systems, returns the 32 bit "System32" folder. eg: C:\Windows\System32 or C:\Windows\SysWow64. Platforms other than Windows this is a synonym for <root folder>Ubu:9.0, Lin:9.0, Mac:9.0, HPUX:9.0, AIX:9.0, Sol:9.0, Win:9.0
application <string> of <folder><application>

Plural: applications
Returns an application object for the named file located in the folder. See application.Win, Lin, Sol, HPUX, AIX, WM, Ubu:8.1
descendant folder of <folder><folder>

Plural: descendant folders
Returns the descendant folders, recursively, of the given folder. The folder equivalent of "descendants of <folder>".Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
descendant of <folder><file>

Plural: descendants
Returns a list of all the descendant files of the specified folder.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
device file <string> of <folder><device file>

Plural: device files
Returns the device file with the specified name in the given folder.Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Ubu:8.1
device file of <folder><device file>

Plural: device files
Returns the device files that exist in the specified folder.Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Ubu:8.1
drive of <folder><filesystem>

Plural: drives
Returns the drive associated with the specified folder.On Macintosh computers, this returns a <volume> object.On *nix computers, this returns a <filesystem> object.Lin, Sol, HPUX, AIX, Ubu:8.1
fifo file <string> of <folder><fifo file>

Plural: fifo files
Returns the FIFO file (named pipe) with the given name in the specified folder.Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Ubu:8.1
fifo file of <folder><fifo file>

Plural: fifo files
Returns the list of FIFO file in the given folder.Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Ubu:8.1
file <string> of <folder><file>

Plural: files
Returns a file object for the named file located in the folder.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
file of <folder><file>

Plural: files
Iterates through the files of a folder returning file objects. When combined with a whose clause you can select files with specific properties. See file.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
filesystem of <folder><filesystem>

Plural: filesystems
Returns the filesystem on which the folder resides. On a Macintosh, this Inspector returns a <volume> object.Lin, Sol, HPUX, AIX, Ubu:8.1
find file <string> of <folder><file>

Plural: find files
Iterates through the files of a folder returning file objects whose name matches the wildcard string provided in the name parameter. A wildcard string uses an asterisk to stand for any number of characters (incuding zero), and a question mark to stand for exactly one character. Thus A??.txt would match All.txt and AXE.txt but not all.txt or a.txt. See example below.Win, Lin, Sol, HPUX, AIX, Mac:8.0, WM, Ubu:8.1
find folder <string> of <folder><folder>

Plural: find folders
Finds the folder with the given wildcard name inside another folder. A wildcard string uses an asterisk to stand for any number of characters (incuding zero), and a question mark to stand for exactly one character. Thus A??.txt would match All.txt and AXE.txt but not all.txt or a.txt.Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1
folder <string> of <folder><folder>

Plural: folders
Returns a folder object for the named sub-folder. Trailing slashes should be omitted from the name.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
folder of <folder><folder>

Plural: folders
Iterates through the folders of a folder returning folder objects. When combined with a whose clause, you can select folders with specific properties.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
socket file <string> of <folder><socket file>

Plural: socket files
Returns the socket file with the given name in the specified folder.Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Ubu:8.1
socket file of <folder><socket file>

Plural: socket files
Returns the socket file(s) in the specified folder.Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Ubu:8.1
symlink <string> of <folder><symlink>

Plural: symlinks
Returns the named symlink from the specified folder.Lin, Sol, HPUX, AIX, Ubu:8.1
symlink of <folder><symlink>

Plural: symlinks
Returns the symlink(s) in the specified folder, whether or not they are broken. Note: This behavior differs from looking for files in a folder. Although that returns links along with the files, it doesn't return broken links.Lin, Sol, HPUX, AIX, Ubu:8.1

drive

The <drive> object is available to inspect these aspects of the file system.

Creation Methods

DeclarationDescriptionPlatforms (?)

Properties

DeclarationReturn typeDescriptionPlatforms (?)

bundle

On HPUX platforms, a bundle object is derived from a product type and used to inspect software installations as managed by the Software Depot. On Macintosh platforms, a bundle refers to a core foundation folder hierarchy derived from CFBundle.

Creation Methods

DeclarationDescriptionPlatforms (?)

Properties

DeclarationReturn typeDescriptionPlatforms (?)

volume

The <volume> Inspectors refer to the mounted drive volumes.

Creation Methods

DeclarationDescriptionPlatforms (?)

Operators

DeclarationReturn TypeDescriptionPlatforms (?)

Properties

DeclarationReturn typeDescriptionPlatforms (?)

file shortcut

Shortcuts to files can be constructed in the file system. The shortcut contains some additional properties that can be inspected.

Creation Methods

DeclarationDescriptionPlatforms (?)

Properties

DeclarationReturn typeDescriptionPlatforms (?)

file section

Many programs and utilities store their settings in 'ini' files. This object is designed to access these settings. An 'ini' file is composed of zero or more named sections, each with zero or more keys. Each key is identified by name and has a string value.

Creation Methods

DeclarationDescriptionPlatforms (?)
section <string> of <file>Returns a named section of a file. Useful for locating sections of 'ini' files. Section names are delimited by square bracket characters '[section name]'. See examples below.

Example:
exists Section "General" of file "oeminfo.ini" of system folder - Returns TRUE if a section named "General" appears in the named "ini" file.

Example:
key "Manufacturer" of section "General" of file "oeminfo.ini" of system folder - Returns the name of the computer manufacturer, such as "Dell Computer Corporation".

Example:
key "Manufacturer" of section "General" of file "/etc/oeminfo" - Returns the value of the "Manufacturer" key of the section named "General" of the specified file.

Example:
key "Manufacturer" of section "General" of file "/etc/oeminfo" - Returns the value of the "Manufacturer" key of the section named "General" of the specified file.
Win, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1

Properties

DeclarationReturn typeDescriptionPlatforms (?)
key <string> of <file section><string>

Plural: keys
Returns a string containing the value for the name provided. A case-insensitive search is performed through the section of the file.Win, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1

file content

Content objects can be constructed from file objects to inspect their contents.

Creation Methods

DeclarationDescriptionPlatforms (?)
content of <file>Returns an object that can be used to search for a string in the file. See content.

Example:
content of file "oeminfo.ini" of system folder as lowercase contains "dell" - Returns TRUE if the specified file contains the string "dell" anywhere in the file.

Example:
content of file "oeminfo.ini" of system folder as lowercase contains "emachines" - Returns TRUE if either of the strings "emachines" or "eMachines" is found in the file.
Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<file content> as lowercaseReturns a lowercase version of the content provided.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<file content> as uppercaseReturns an uppercase version of the content provided.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1

Operators

DeclarationReturn TypeDescriptionPlatforms (?)
<file content> contains <string><boolean>Returns TRUE if the string is located in the content provided.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1

Properties

DeclarationReturn typeDescriptionPlatforms (?)
<file content> as lowercase<file content>Returns a lowercase version of the content provided.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<file content> as uppercase<file content>Returns an uppercase version of the content provided.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1

version

This is the numeric method of indicating the file version, which is compact, convenient and fast. It makes use of a short string to define the version number. Version types are available as both client and core Inspectors, so if you don't find what you want in one guide, please check the other.

Creation Methods

DeclarationDescriptionPlatforms (?)
<string> as versionReturns a version if the string can be parsed as a version. The first numeric set of characters delimited with period, comma or comma-space is returned.Win, WM, Lin, Mac, HPUX, AIX, Sol, Ubu:8.1
version <string>Short hand for 'file version'.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<string> as versionReturns a version if the string can be parsed as a version. The first numeric set of characters delimited with period, comma or comma-space is returned.Win, WM, Lin, Mac, HPUX, AIX, Sol, Ubu:8.1
<version> as versionReflexive cast of version.Win, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, WM, Ubu:8.1
maximum of <version>Returns the maximum value from a list of <version> types.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
minimum of <version>Returns the minimum value from a list of <version> types.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
version of <operating system>Returns the version of the operating system.Win:8.0, Lin:8.2, Sol:8.2, HPUX:8.2, AIX:8.2, Mac:8.0, Ubu:8.2
version of <service>This Inspector takes the specified service property and retrieves its version (file version).

Example:
version of service "BESClient" - Returns a version number, such as '8.0.584.0'.
Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Ubu:8.1
version of <client>The product version of the BES application (BESClient or QnA).Note: On the Macintosh only, this Inspector returns a <string>.

Example:
version of client as string - Returns a string like "4.0.3.7".
Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
version of <current relay>Returns a version object that is the version of the server that the client last registered with. This may be a BES Relay or the BES root server.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
version of <application usage summary instance>Returns the version of the specified application instance.Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1
version of <package>Returns the version of the given RPM package.Lin, AIX:8.2

Operators

DeclarationReturn TypeDescriptionPlatforms (?)
<version> {cmp} <string><boolean>Returns a boolean TRUE or FALSE, depending on the comparison operator, where:{cmp} is one of: =, !=, <, <=, >, >= .Win, Lin, Sol, HPUX, AIX, Mac, WM
<string> {cmp} <version><boolean>Returns a boolean TRUE or FALSE, depending on the comparison operator, where:{cmp} is one of: =, !=, <, <=, >, >= .Win, Lin, Sol, HPUX, AIX, Mac, WM
<string> {cmp} <version><boolean>Returns a boolean TRUE or FALSE, depending on the comparison operator, where:{cmp} is one of: =, !=, <, <=, >, >= .Win, Lin, Sol, HPUX, AIX, Mac, WM
<version> {cmp} <version><boolean>Returns a boolean TRUE or FALSE, depending on the comparison operator, where:{cmp} is one of: =, !=, <, <=, >, >= .Win, Lin, Sol, HPUX, AIX, Mac, WM

Properties

DeclarationReturn typeDescriptionPlatforms (?)
<string> as version<version>Returns a version if the string can be parsed as a version. The first numeric set of characters delimited with period, comma or comma-space is returned.Win, WM, Lin, Mac, HPUX, AIX, Sol, Ubu:8.1
<version> as string<string>Turns a version type into a string of the form "1.2.3.4".Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<version> as version<version>Reflexive cast of version.Win, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, WM, Ubu:8.1
extrema of <version><( version, version )>

Plural: extremas
Returns the minimum and maximum extreme values of the given list of <version> types.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
maximum of <version><version>

Plural: maxima
Returns the maximum value from a list of <version> types.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
minimum of <version><version>

Plural: minima
Returns the minimum value from a list of <version> types.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
unique value of <version><version with multiplicity>

Plural: unique values
Returns the unique values of a given list of <version> types, removing duplicates and sorting by value.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1

version with multiplicity

The <version with multiplicity> Inspectors deal with version arrays, allowing you to extract unique version values and count them.

Creation Methods

DeclarationDescriptionPlatforms (?)
unique value of <version>Returns the unique values of a given list of <version> types, removing duplicates and sorting by value.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1

Properties

DeclarationReturn typeDescriptionPlatforms (?)
multiplicity of <version with multiplicity><integer>

Plural: multiplicities
Sorts the list and returns the multiplicity, or count, of each unique element in the specified list of multiple <version> types.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1

file version block

You can inspect the version blocks of a file. There may be several language-specific version blocks. Version blocks contain version and name information in a human readable form for the specified language. This is the information that Windows displays in the file properties dialog. This technique uses string values and has a limited array of comparators. For better speed, utility and compactness see the version object.

Creation Methods

DeclarationDescriptionPlatforms (?)

Properties

DeclarationReturn typeDescriptionPlatforms (?)

strverscmp version

Uses the OS supplied strverscmp function, which may be useful for certain older-style version comparisons. For more information, see the man page for strverscmp.

Creation Methods

DeclarationDescriptionPlatforms (?)
<string> as strverscmp versionConverts a string to strverscmp version, which is compared to other versions using the OS supplied strverscmp function.Ubu:8.1, Lin
strverscmp version <string>Creates a strverscmp version, which is compared to other versions using the OS supplied strverscmp function.Lin, Ubu:8.1

Operators

DeclarationReturn TypeDescriptionPlatforms (?)
<string> {cmp} <strverscmp version><boolean>Returns a boolean TRUE/FALSE depending on the result of the comparison (based on the OS supplied strverscmp function), where:{cmp} is one of: =, !=, <, <=, >, >= .Lin, WM, Ubu:8.1
<strverscmp version> {cmp} <string><boolean>Returns a boolean TRUE/FALSE depending on the result of the comparison (based on the OS supplied strverscmp function), where:{cmp} is one of: =, !=, <, <=, >, >= .Lin, WM, Ubu:8.1
<strverscmp version> {cmp} <strverscmp version><boolean>Returns a boolean TRUE/FALSE depending on the result of the comparison (based on the OS supplied strverscmp function), where:{cmp} is one of: =, !=, <, <=, >, >= .Lin

Properties

DeclarationReturn typeDescriptionPlatforms (?)

domain

Mac OS X defines several file system domains to control access to system resources on multi-user systems. These include the User, Local, Network, Classic and System domains. The domain for a given resource or folder determines its accessibility to the user. For example, while a user-installed font is only available to that user, an administrator-installed font is available to all network users. These Inspectors allow folder access to be parceled out according to domain.Note: The "user domain" refers to the root user, not the currently logged in user.

Creation Methods

DeclarationDescriptionPlatforms (?)

Properties

DeclarationReturn typeDescriptionPlatforms (?)

mode

The <mode> inpector returns file type information and permissions. These are the possible values of mode:S_IFMT 170000 bitmask for the file type bitfieldsS_IFSOCK 140000 socketS_IFLNK 120000 symbolic linkS_IFREG 100000 regular fileS_IFBLK 060000 block deviceS_IFDIR 040000 directoryS_IFCHR 020000 character deviceS_IFIFO 010000 fifoS_ISUID 004000 set UID bitS_ISGID 002000 set GID bitS_ISVTX 001000 sticky bitS_IRWXU 000700 mask for file owner permissionsS_IRUSR 000400 owner has read permissionS_IWUSR 000200 owner has write permissionS_IXUSR 000100 owner has execute permissionS_IRWXG 000070 mask for group permissionsS_IRGRP 000040 group has read permissionS_IWGRP 000020 group has write permissionS_IXGRP 000010 group has execute permissionS_IRWXO 000007 mask for permissions for others (not in group)S_IROTH 000004 others have read permissionS_IWOTH 000002 others have write permissionS_IXOTH 000001 others have execute permission

Creation Methods

DeclarationDescriptionPlatforms (?)
mode of <filesystem object>Returns the permissions mode for the given filesystem object.Lin, Sol, HPUX, AIX, Ubu:8.1

Properties

DeclarationReturn typeDescriptionPlatforms (?)
<mode> as octal string<string>Converts the mode to a string of octal numbers.Lin, Sol, HPUX, AIX, Ubu:8.1
<mode> as string<string>Converts the mode to a string.Lin, Sol, HPUX, AIX, Ubu:8.1
group mask of <mode><mode_mask>

Plural: group masks
Returns the mask for group permissions for the given mode.Lin, Sol, HPUX, AIX, Ubu:8.1
other mask of <mode><mode_mask>

Plural: other masks
Returns the mask for permissions for others (those not in the group) for the given mode.Lin, Sol, HPUX, AIX, Ubu:8.1
setgid of <mode><boolean>

Plural: setgids
Returns TRUE if setgid (the group ID flag) is set.Lin, Sol, HPUX, AIX, Ubu:8.1
setuid of <mode><boolean>

Plural: setuids
Returns TRUE if setuid (the user ID flag) is set.Lin, Sol, HPUX, AIX, Ubu:8.1
sticky of <mode><boolean>

Plural: stickies
The `sticky' bit (S_ISVTX) on a directory means that a file in that directory can be renamed or deleted only by the owner of the file, by the owner of the directory, and by root. This inspector returns TRUE if the sticky bit of the given mode is on.Lin, Sol, HPUX, AIX, Ubu:8.1
user mask of <mode><mode_mask>

Plural: user masks
Returns the mask for the user (file owner) permissions for the given mode.Lin, Sol, HPUX, AIX, Ubu:8.1

mode_mask

The <mode_mask> Inspector is a differently formatted version of the mode, created by shifting the key information down to the low three bits.

Creation Methods

DeclarationDescriptionPlatforms (?)
group mask of <mode>Returns the mask for group permissions for the given mode.Lin, Sol, HPUX, AIX, Ubu:8.1
other mask of <mode>Returns the mask for permissions for others (those not in the group) for the given mode.Lin, Sol, HPUX, AIX, Ubu:8.1
user mask of <mode>Returns the mask for the user (file owner) permissions for the given mode.Lin, Sol, HPUX, AIX, Ubu:8.1

Properties

DeclarationReturn typeDescriptionPlatforms (?)
<mode_mask> as integer<integer>Converts the mode mask to an integer, 1-4.Lin, Sol, HPUX, AIX, Ubu:8.1
<mode_mask> as string<string>Converts the mode mask to a string, for example "rwx".Lin, Sol, HPUX, AIX, Ubu:8.1
execute of <mode_mask><boolean>

Plural: executes
Returns TRUE if the execute flag (x) of the rwx mode mask is on. (binary 001 = 1).Lin, Sol, HPUX, AIX, Ubu:8.1
read of <mode_mask><boolean>

Plural: reads
Returns TRUE if the read flag of the rwx mode mask is on. (binary 100 = 4).Lin, Sol, HPUX, AIX, Ubu:8.1
write of <mode_mask><boolean>

Plural: writes
Returns TRUE if the write flag (w) of the rwx mode mask is on. (binary 010 = 2).Lin, Sol, HPUX, AIX, Ubu:8.1

file type

The <file type> Inspectors provide access to the four character file type associated with some types of files.

Creation Methods

DeclarationDescriptionPlatforms (?)

Operators

DeclarationReturn TypeDescriptionPlatforms (?)

Properties

DeclarationReturn typeDescriptionPlatforms (?)

file signature

The <file signature> Inspectors provide access to each of the four character file signatures associated with some types of files.

Creation Methods

DeclarationDescriptionPlatforms (?)

Operators

DeclarationReturn TypeDescriptionPlatforms (?)

Properties

DeclarationReturn typeDescriptionPlatforms (?)

component

Components are handled by the MacOS Component Manager. These Inspectors provide access to the various software components available through the Component Manager. The information contained in a component is placed there by its maker. How it should be interpreted is also determined by the maker.

Creation Methods

DeclarationDescriptionPlatforms (?)

Properties

DeclarationReturn typeDescriptionPlatforms (?)

datafork

The <datafork> Inspectors refer to the data fork of a filesystem object.

Creation Methods

DeclarationDescriptionPlatforms (?)

Properties

DeclarationReturn typeDescriptionPlatforms (?)

resfork

The <resfork> Inspectors refer to the resource fork of a filesystem object.

Creation Methods

DeclarationDescriptionPlatforms (?)

Properties

DeclarationReturn typeDescriptionPlatforms (?)

dictionaryentry

The <dictionaryentry> inspectors provide access to the entries of a dictionary.

Creation Methods

DeclarationDescriptionPlatforms (?)

Properties

DeclarationReturn typeDescriptionPlatforms (?)

dictionary

The <dictionary> Inspectors provide access to an XML dictionary as used in .plist (property list) files.

Creation Methods

DeclarationDescriptionPlatforms (?)

Properties

DeclarationReturn typeDescriptionPlatforms (?)

country

The <country> Inspectors allow comparing countries (as seen in version numbers).

Creation Methods

DeclarationDescriptionPlatforms (?)

Operators

DeclarationReturn TypeDescriptionPlatforms (?)

Properties

DeclarationReturn typeDescriptionPlatforms (?)

osxvalue

The <osxvalue> Inspectors provide access to the elements of a dictionary.

Creation Methods

DeclarationDescriptionPlatforms (?)

Properties

DeclarationReturn typeDescriptionPlatforms (?)

preference

The <preference> Inspectors provide access to application preference files.

Creation Methods

DeclarationDescriptionPlatforms (?)

Properties

DeclarationReturn typeDescriptionPlatforms (?)

stage

The <stage> objects are for inspecting the stage portion of version numbers, which is the penultimate section of a version string: Major.Minor.ReleaseStageBuild.

Creation Methods

DeclarationDescriptionPlatforms (?)

Properties

DeclarationReturn typeDescriptionPlatforms (?)

fileset

The <fileset> objects represent the set of files required for installing a software package.

Creation Methods

DeclarationDescriptionPlatforms (?)

Properties

DeclarationReturn typeDescriptionPlatforms (?)

file line

A <file line> object produces strings from a text file.

Creation Methods

DeclarationDescriptionPlatforms (?)
line <integer> of <file>Returns the nth line (specified by <integer>) from the given file.

Example:
line 2 of (file "printmon.inf" of system folder) - Returns the second line of the specified file.
Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
line containing <string> of <file>Returns all lines from the given file that contain the specified string.

Example:
lines containing "Signature]" of file "mmdriver.inf" of system folder - Returns a list corresponding to the top-level sections involving signatures in the specified .inf file.
Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
line of <file>Iterates over all the lines of the specified file. Note that the lines are truncated to 1023 characters.

Example:
lines of file "c:\autoexec.bat" - Returns all the lines in the specified autoexec.bat file.
Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
line starting with <string> of <file>Same as line <string> of <file>, returns the lines of the given file that start with the specified string.

Example:
lines starting with "[" of file "mmdriver.inf" of system folder - Returns a list corresponding to all the top-level sections (lines that start with "[") in the specified .inf file.
Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
next line of <file line>Returns the line after the specified line in a file (provided that it is not the last line). This Inspector can be chained indefinitely, eg., next line of next line of ...

Example:
next line of line containing "[mciavi]" of file "mmdriver.inf" of system folder - Returns the line after the one containing "[mciavi]", which is a string such as "1:MSVFW32.DLL".
Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
previous line of <file line>Returns the line before the nth line in a file, provided n>1. You may repeat this command up to three times.

Example:
previous line of previous line of previous line of line containing "[mciavi]" of file "mmdriver.inf" of system folder - Returns the line 3 lines previous to the one containing the specified phrase in the given file.
Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1

Properties

DeclarationReturn typeDescriptionPlatforms (?)
line number of <file line><integer>

Plural: line numbers
Returns the line number of a given line. Can be used to locate specific lines in a file.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
next line of <file line><file line>

Plural: next lines
Returns the line after the specified line in a file (provided that it is not the last line). This Inspector can be chained indefinitely, eg., next line of next line of ...Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
previous line of <file line><file line>

Plural: previous lines
Returns the line before the nth line in a file, provided n>1. You may repeat this command up to three times.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1

xml dom node

The <xml dom node> objects are the Inspectors for the XML Document Object Module (DOM) nodes. The console uses MSXML 6.0 if it is available. Otherwise it falls back to 4.0. The console requires at least 4.0 since 3.0 does not provide XML schema validation.

Creation Methods

DeclarationDescriptionPlatforms (?)

Properties

DeclarationReturn typeDescriptionPlatforms (?)

symlink

Symlinks, or symbolic links, are the Unix version of shortcut files (pointers to other files). Inspectors can analyze the file objects (files and folders) that symlinks point to by using the standard file Inspectors. The symlink Inspectors, on the other hand, allow you to analyze the properties of a symlink itself, not just the underlying file. There are many properties that symlinks have in common with files, such as name, pathname, parent folder, and more. In addition, a symlink has a value corresponding to the file object it points to. You can also determine if the file is available or not.

Creation Methods

DeclarationDescriptionPlatforms (?)
symlink <filesystem object>Returns a symlink from the specified filesystem object.Lin, Sol, HPUX, AIX, Ubu:8.1
symlink <string>Returns a symlink from the specified string.Lin, Sol, HPUX, AIX, Ubu:8.1
symlink <symlink>Returns a symlink from the specified symlink path, even if the symlink is broken.Lin, Sol, HPUX, AIX, Ubu:8.1
<filesystem object> as symlinkCasts a link in the form of a file into a symlink.

Example:
file "/example/link" as symlink - Returns the link (in file format) as a symlink object ("/example/link").
Lin, Sol, HPUX, AIX, Ubu:8.1
symlink <string> of <folder>Returns the named symlink from the specified folder.Lin, Sol, HPUX, AIX, Ubu:8.1
symlink of <folder>Returns the symlink(s) in the specified folder, whether or not they are broken. Note: This behavior differs from looking for files in a folder. Although that returns links along with the files, it doesn't return broken links.

Example:
symlinks of folder "/example" - Returns a list of the symlink in the specified folder, whether or not they are broken. Note that this behavior is different from looking for files in a folder -- that will return links as well as files, but won't return broken links.
Lin, Sol, HPUX, AIX, Ubu:8.1
<symlink> as symlinkCasts a symlink, provided for completeness.Lin, Sol, HPUX, AIX, Ubu:8.1

Properties

DeclarationReturn typeDescriptionPlatforms (?)
<symlink> as device file<device file>Casts a symlink type as a device file type.Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Ubu:8.1
<symlink> as fifo file<fifo file>Casts a symlink object as a fifo file.Lin:8.2, Sol:8.2, HPUX:8.2, AIX:8.2, Ubu:8.1
<symlink> as fifo file<fifo file>Casts a symlink type as a FIFO (named pipe) file.Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Ubu:8.1
<symlink> as file<file>Converts a symlink object into the file it points to.Lin, Sol, HPUX, AIX, Ubu:8.1
<symlink> as folder<folder>Converts a symlink object into the folder it points to.Lin, Sol, HPUX, AIX, Ubu:8.1
<symlink> as socket file<socket file>Casts a symlink type as a socket file type.Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Ubu:8.1
<symlink> as string<string>Casts a symlink object as a string.Lin, Sol, HPUX, AIX, Ubu:8.1
<symlink> as symlink<symlink>Casts a symlink, provided for completeness.Lin, Sol, HPUX, AIX, Ubu:8.1
accessed time of <symlink><time>

Plural: accessed times
Returns the last accessed time of the specified symlink.Lin, Sol, HPUX, AIX, Ubu:8.1
ancestor of <symlink><folder>

Plural: ancestors
Returns all ancestor folders (recursive parent folders) of the given symlink.Lin, Sol, HPUX, AIX, Ubu:8.1
change time of <symlink><time>

Plural: change times
Returns the last time the specified symlink was 'changed' by either writing it or setting its inode information.Lin, Sol, HPUX, AIX, Ubu:8.1
drive of <symlink><filesystem>

Plural: drives
Returns the drive associated with the specified symlink as a <filesystem> object.Lin, Sol, HPUX, AIX, Ubu:8.1
filesystem of <symlink><filesystem>

Plural: filesystems
Returns the filesystem on which the symlink resides.Lin, Sol, HPUX, AIX, Ubu:8.1
gid of <symlink><integer>

Plural: gids
Returns the group ID of the given symlink.Lin, Sol, HPUX, AIX, Ubu:8.1
group name of <symlink><string>

Plural: group names
Returns the group name of the specified symlink.Lin, Sol, HPUX, AIX, Ubu:8.1
link count of <symlink><integer>

Plural: link counts
Returns an integer corresponding to the number of hard links attached to the specified symlink.Lin, Sol, HPUX, AIX, Ubu:8.1
location of <symlink><string>

Plural: locations
Returns a string corresponding to the directory in which the symlink is located.Lin, Sol, HPUX, AIX, Ubu:8.1
modification time of <symlink><time>

Plural: modification times
Returns the time corresponding to the modification time of the specified symlink, not the file it points to.Lin, Sol, HPUX, AIX, Ubu:8.1
name of <symlink><string>

Plural: names
Returns a string that is the full pathname of the specified symlink.Lin, Sol, HPUX, AIX, Ubu:8.1
parent folder of <symlink><folder>

Plural: parent folders
Creates a folder object corresponding to the parent folder of the given symlink.Lin, Sol, HPUX, AIX, Ubu:8.1
pathname of <symlink><string>

Plural: pathnames
Returns a string that contains the full pathname of the specified symlink.Lin, Sol, HPUX, AIX, Ubu:8.1
uid of <symlink><integer>

Plural: uids
The user ID of the user who owns this symlink.Lin, Sol, HPUX, AIX, Ubu:8.1
user name of <symlink><string>

Plural: user names
Returns the symlink owner's (user's) name.Lin, Sol, HPUX, AIX, Ubu:8.1
value accessible of <symlink><boolean>

Plural: values accessible
Returns TRUE if the pathname pointed to by the specified symlink is available. Returns FALSE if the file object is missing or unavailable with the current permissions.Lin, Sol, HPUX, AIX, Ubu:8.1
value of <symlink><string>

Plural: values
Returns the pathname that the symlink points to.Lin, Sol, HPUX, AIX, Ubu:8.1

logical volume manager

On AIX, the logical volume manager provides a flexible means of allocating disk space using volume groups, logical volumes, and physical volumes. A volume group is a collection of one or more physical volumes and a logical volume is an abstraction representing a pool of disk space. The disk space assigned to a logical volume appears contiguous to the user, but it may actually be distributed across one or more physical volumes within a single volume group.

Creation Methods

DeclarationDescriptionPlatforms (?)

Properties

DeclarationReturn typeDescriptionPlatforms (?)

logical volume

A logical volume consists of an array of identically sized logical partitions. The partition size of a logical volume is determined by the volume group that contains it, and is the same as the volume group's physical partition size. Contiguous logical partitions within a logical volume may map to discontiguous physical partitions, possibly distributed across multiple physical volumes. A logical volume may be configured so that its logical partitions are mirrored to protect data from hardware failures. Mirroring may be configured so that each logical partition maps to either 2 or 3 physical partition mirrors.

Creation Methods

DeclarationDescriptionPlatforms (?)

Properties

DeclarationReturn typeDescriptionPlatforms (?)

volume group

On AIX systems, physical disk volumes are organized into volume groups. The partition size of a physical volume is determined by the volume group that it belongs to. If multiple physical volumes belong to the same volume group, then they must all have the same partition size. A typical partition size might be 16 or 32 megabytes.

Creation Methods

DeclarationDescriptionPlatforms (?)

Properties

DeclarationReturn typeDescriptionPlatforms (?)

download storage folder

Before an Action executes, the download storage folder points to a temporary directory that holds the downloads for the Action. During execution of the Action, those downloads are moved to the standard BigFix __Download folder and the Inspector then points there. These Inspectors return information about the currently specified download storage folder, and can be used with relevance substitution in download and prefetch Action commands.

Creation Methods

DeclarationDescriptionPlatforms (?)
download storage folderThis Inspector creates a pointer to the current download storage folder.Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Ubu:8.1

Properties

DeclarationReturn typeDescriptionPlatforms (?)
total size of <download storage folder><integer>

Plural: total sizes
Returns the amount of storage currently being used to store downloads (in bytes).Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Ubu:8.1

device file

These Inspector types interrogate Unix-style device files, which contain device drivers or system resources. Unix identifies these resources by a major number and a minor number, both stored as part of a node structure. Typically, the major number identifies the device driver and the minor number identifies the particular device controlled by that driver.

Creation Methods

DeclarationDescriptionPlatforms (?)
device file <filesystem object>Returns the device file indicated by the specified filesystem object.Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Ubu:8.1
device file <string>Returns the device file with the specified name.Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Ubu:8.1
device file <symlink>Returns the device file specified by the supplied symbolic link.Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Ubu:8.1
<filesystem object> as device fileReturns a device file or nothing (if the filesystem object specified is not a device file).Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Ubu:8.1
device file <string> of <folder>Returns the device file with the specified name in the given folder.Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Ubu:8.1
device file of <folder>Returns the device files that exist in the specified folder.Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Ubu:8.1
<symlink> as device fileCasts a symlink type as a device file type.Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Ubu:8.1

Properties

DeclarationReturn typeDescriptionPlatforms (?)
device type of <device file><string>

Plural: device types
Returns the device type corresponding to the give device file, as a string.Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Ubu:8.1
drive of <device file><filesystem>

Plural: drives
Returns the drive associated with the specified device file.Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Ubu:8.1
filesystem of <device file><filesystem>

Plural: filesystems
Returns the filesystem object corresponding to the specified device file.Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Ubu:8.1
major of <device file><integer>

Plural: majors
Returns the major number of the specified device file.Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Ubu:8.1
minor of <device file><integer>

Plural: minors
Returns the minor number of the specified device file.Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Ubu:8.1

fifo file

In Unix systems, a FIFO file is a named pipe that uses the file system as a way to store the pipe name. These Inspectors provide access to these named pipes.

Creation Methods

DeclarationDescriptionPlatforms (?)
fifo file <filesystem object>Returns the FIFO file (named pipe) described by the specified filesytem object.Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Ubu:8.1
fifo file <string>Returns the FIFO file (named pipe) with the given name.Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Ubu:8.1
fifo file <symlink>Returns the FIFO file (named pipe) described by the specified symbolic link (symlink).Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Ubu:8.1
<filesystem object> as fifo fileReturns a FIFO file or nothing (if the filesystem object specified is not a FIFO file).Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Ubu:8.1
fifo file <string> of <folder>Returns the FIFO file (named pipe) with the given name in the specified folder.Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Ubu:8.1
fifo file of <folder>Returns the list of FIFO file in the given folder.Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Ubu:8.1
<symlink> as fifo fileCasts a symlink object as a fifo file.Lin:8.2, Sol:8.2, HPUX:8.2, AIX:8.2, Ubu:8.1
<symlink> as fifo fileCasts a symlink type as a FIFO (named pipe) file.Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Ubu:8.1

Properties

DeclarationReturn typeDescriptionPlatforms (?)
drive of <fifo file><filesystem>

Plural: drives
Returns the drive associated with the specified FIFO (named pipe) file.Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Ubu:8.1
filesystem of <fifo file><filesystem>

Plural: filesystems
Returns the filesystem object corresponding to the specified FIFO file.Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Ubu:8.1

socket file

The <socket file> Inspectors allow you to interrogate socket files, which are representations of UNIX domain sockets identified by their pathname.

Creation Methods

DeclarationDescriptionPlatforms (?)
socket file <filesystem object>Returns the socket file(s) indicated by the supplied filesystem object.Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Ubu:8.1
socket file <string>Returns the named socket file.Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Ubu:8.1
socket file <symlink>Returns the socket file(s) indicated by the supplied symlink.Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Ubu:8.1
<filesystem object> as socket fileCasts a given filesystem object as a socket file.Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Ubu:8.1
socket file <string> of <folder>Returns the socket file with the given name in the specified folder.Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Ubu:8.1
socket file of <folder>Returns the socket file(s) in the specified folder.Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Ubu:8.1
<symlink> as socket fileCasts a symlink type as a socket file type.Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Ubu:8.1

Properties

DeclarationReturn typeDescriptionPlatforms (?)
drive of <socket file><filesystem>

Plural: drives
Returns the drive associated with the specified socket file.Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Ubu:8.1
filesystem of <socket file><filesystem>

Plural: filesystems
Returns the filesystem object corresponding to the specified socket file.Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Ubu:8.1